Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update dev-docs #8730

Merged
merged 16 commits into from May 4, 2023
Merged

Update dev-docs #8730

merged 16 commits into from May 4, 2023

Conversation

esc
Copy link
Member

@esc esc commented Jan 27, 2023

This is variant of #7367 -- but with conflicts resolved to main on 2022-01-27.

sgbaird and others added 11 commits September 3, 2021 20:19
@sgbaird
add numba/label/ci_llvmlite_0.38 as channel and note about Windows sq…
c727f0c 
…lite3
@sgbaird
install rtd theme and note that build occurs under docs/ folder
ad41a7b
@sgbaird
proper indentation
75da906
@sgbaird
change channel to numba/label/dev per esc comment
363d9e8
@sgbaird
hyperlink had space
51dba44
@sgbaird
Merge branch 'dev-docs' of https://github.com/sparks-baird/numba into…
6e979d2 
… dev-docs
@sgbaird
change pip to conda install
f4a67ef
@sgbaird
remove reference about using pre-commit hooks on Windows
9431bf3
@sgbaird
remove reference to bootstrap theme
3f408db
@sgbaird @gmarkall
Update docs/source/developer/contributing.rst
59e6da1 
Co-authored-by: Graham Markall <535640+gmarkall@users.noreply.github.com>
@esc
Merge branch 'main' into dev-docs
a297d12 
* main: (2583 commits)
  Correct sequence in test_issue_3158_1
  Fix flake8 checks since upgrade to flake8=6.x
  Use nonzero data in tests of Issue numba#3158
  Apply suggestions from PR numba#8120 review
  Make Numba dependency check run ahead of Numba internal imports.
  Check for void return type in compile_ptx
  applying review suggestions
  Add -e to all Azure script steps
  CI: Use `set -e` in "Before Install" step and fix install
  Implement cleanups suggested in PR numba#8120 feedback
  Remove cpu NRT init guard, rtsys.initialize already has this.
  remove forced fail test
  moved file (2)
  Add test for docstring.
  Add update_wrapper to dufunc.
  Remove superfluous assertion.
  Fix failing warning checking tests.
  Fix failing tests.
  * now uses np.testing.assert_array_equal for more detailed error reporting
  Supply concrete timeline for objmode fallback deprecation.
  ...
@esc esc mentioned this pull request Jan 27, 2023
Closed
@esc
Copy link
Member Author

esc commented Jan 27, 2023

@gmarkall I just read through it again, and perhaps we can remove the channel setup. The docs now list using the numba/label/dev:: syntax.

gmarkall
gmarkall requested changes Feb 6, 2023
View reviewed changes
Copy link
Member

@gmarkall gmarkall left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree, we can remove the section about the channel setup since the docs already specify installing llvmlite from the numba/label/dev channel:

$ conda create -n numbaenv python=3.10 numba/label/dev::llvmlite numpy scipy jinja2 cffi

@stuartarchibald stuartarchibald added the 4 - Waiting on author Waiting for author to respond to review label Feb 6, 2023
@esc
Copy link
Member Author

esc commented Feb 6, 2023

I agree, we can remove the section about the channel setup since the docs already specify installing llvmlite from the numba/label/dev channel:

$ conda create -n numbaenv python=3.10 numba/label/dev::llvmlite numpy scipy jinja2 cffi

Thank you @gmarkall -- I opted to remove the section. I also noticed, while writing, that the installation instructions for the dependencies were somewhat conflated. With examples in the paragraph above and then a concrete command below. In the interest of good reading flow, I opted to list all the dependencies for the docs within a single command. I am hoping this is less confusing and makes it very clear what dependencies are needed to build the docs for Numba. May I please have a re-review? Thank you.

@stuartarchibald stuartarchibald added 4 - Waiting on reviewer Waiting for reviewer to respond to author and removed 4 - Waiting on author Waiting for author to respond to review labels Feb 6, 2023
gmarkall
gmarkall requested changes Apr 12, 2023
View reviewed changes
Copy link
Member

@gmarkall gmarkall left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are a couple of rendering errors - suggestions added on the diff that I think will resolve them.

docs/source/developer/contributing.rst Outdated Show resolved Hide resolved
docs/source/developer/contributing.rst Outdated Show resolved Hide resolved
@gmarkall gmarkall added 4 - Waiting on author Waiting for author to respond to review and removed 4 - Waiting on reviewer Waiting for reviewer to respond to author labels Apr 21, 2023
esc and others added 2 commits May 4, 2023 10:24
@esc @gmarkall
Fix link to sphinx-rtd-theme
e211a03 
Co-authored-by: Graham Markall <535640+gmarkall@users.noreply.github.com>
@esc @gmarkall
Fix syntax highlighting for shell command.
fc09bb8 
Co-authored-by: Graham Markall <535640+gmarkall@users.noreply.github.com>
@esc esc added 4 - Waiting on reviewer Waiting for reviewer to respond to author and removed 4 - Waiting on author Waiting for author to respond to review labels May 4, 2023
@esc
Copy link
Member Author

esc commented May 4, 2023

@gmarkall thank you for the feedback, I have addressed the review comments and this is now ready for another round of review.

gmarkall
gmarkall approved these changes May 4, 2023
View reviewed changes
Copy link
Member

@gmarkall gmarkall left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Many thanks for the updates!

@gmarkall gmarkall added 5 - Ready to merge Review and testing done, is ready to merge and removed 4 - Waiting on reviewer Waiting for reviewer to respond to author labels May 4, 2023
@gmarkall gmarkall mentioned this pull request May 4, 2023
Merged
@esc
Copy link
Member Author

esc commented May 4, 2023

Many thanks for the updates!

Thank your for the review!

@sklam sklam merged commit 08a514b into numba:main May 4, 2023
22 checks passed
@sklam sklam added this to the Numba 0.58 RC milestone May 4, 2023
@sklam sklam added the skip_release_notes Skip towncrier requirement label Jul 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gmarkall gmarkall gmarkall approved these changes

@sklam sklam Awaiting requested review from sklam

@stuartarchibald stuartarchibald Awaiting requested review from stuartarchibald

Assignees

@gmarkall gmarkall

Labels
5 - Ready to merge Review and testing done, is ready to merge skip_release_notes Skip towncrier requirement
Projects
@esc's tracker
Status: Done
Milestone
Numba 0.58 RC
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@esc @gmarkall @stuartarchibald @sklam @sgbaird